Programming with QuickTime VR

QTVRGetHotSpotRegion

You can use the QTVRGetHotSpotRegion function to get the region occupied by a hot spot.



 
OSErr QTVRGetHotSpotRegion (

                     QTVRInstance qtvr, 

                     UInt32 hotSpotID,

                     RgnHandlehotSpotRegion);

qtvr: An instance of a QuickTime VR movie.
hotSpotID: A hot spot ID.
hotSpotRegion: On entry, an initialized handle to a region (obtained by calling NewRgn ). On exit, this region is rewritten with the region occupied by the hot spot having the specified ID.
function result: A result code.

DESCRIPTION

The QTVRGetHotSpotRegion function returns, in the hotSpotRegion parameter, a handle to the region occupied by the hot spot, in the QuickTime VR movie specified by the qtvr parameter, whose ID is specified by the hotSpotID parameter. The region is clipped to the bounds of the movie's graphics world.

You can obtain the regions of all visible hot spots by calling the QTVRGetVisibleHotSpots function and then calling QTVRGetHotSpotRegion for each hot spot ID in the list.

SPECIAL CONSIDERATIONS

The first time you call QTVRGetHotSpotRegion , a significant amount of memory might need to be allocated. Accordingly, you should always check for Memory Manager errors returned by QTVRGetHotSpotRegion .

Your application is responsible for disposing of the memory occupied by the returned region.